ADC.h

Go to the documentation of this file.

#ifndef _ADC_H
#define _ADC_H

/*
 **************************************************************
 * Defines, Macros and Typedefs 
 **************************************************************/
/*** Constant Macros ***/
/* Default Yes and No defines */
#ifndef TRUE
#define TRUE (1u)
#endif
#ifndef CLEAR
#define CLEAR (0u)
#endif
#ifndef BITS_IN_NIBBLE
#define BITS_IN_NIBBLE (4u)
#endif
#ifndef BITS_IN_BYTE
#define BITS_IN_BYTE (8u)
#endif
#ifndef BYTES_IN_16
#define BYTES_IN_16  (2u)
#endif
#ifndef BYTES_IN_32
#define BYTES_IN_32  (4u)
#endif
#ifndef BITS_IN_32
#define BITS_IN_32  (32u)
#endif
#ifndef BITS_IN_16
#define BITS_IN_16  (16u)
#endif
#ifndef BIT_DEFINITION
#define BIT_DEFINITION
#define BIT0  (1u << 0u)
#define BIT1  (1u << 1u)
#define BIT2  (1u << 2u)
#define BIT3  (1u << 3u)
#define BIT4  (1u << 4u)
#define BIT5  (1u << 5u)
#define BIT6  (1u << 6u)
#define BIT7  (1u << 7u)
#define BIT8  (1u << 8u)
#define BIT9  (1u << 9u)
#define BIT10 (1u << 10)
#define BIT11 (1u << 11)
#define BIT12 (1u << 12)
#define BIT13 (1u << 13)
#define BIT14 (1u << 14)
#define BIT15 (1u << 15)
#define BIT16 (1u << 16)
#define BIT17 (1u << 17)
#define BIT18 (1u << 18)
#define BIT19 (1u << 19)
#define BIT20 (1u << 20)
#define BIT21 (1u << 21)
#define BIT22 (1u << 22)
#define BIT23 (1u << 23)
#define BIT24 (1u << 24)
#define BIT25 (1u << 25)
#define BIT26 (1u << 26)
#define BIT27 (1u << 27)
#define BIT28 (1u << 28)
#define BIT29 (1u << 29)
#define BIT30 (1u << 30)
#define BIT31 (1u << 31)
#endif

/* Instances */
#define ADC_MODULE_0            (0x00u)
#define ADC_MODULE_1            (0x01u)

/* Max and mins */
#define ADC_CH_MAX              ADC_CH15
#define ADC_NO_MODULES          (0x02u)

/* HW Status */
#define ADC_ST_IDLE             (0x00u)
#define ADC_ST_POWER_DOWN       (0x01u)
#define ADC_ST_WAIT             (0x02u)
#define ADC_ST_SAMPLE           (0x04u)
#define ADC_ST_CONVERSION       (0x06u)

/* HW ISR Masks */
#define ADC_ISR_EOCTU_MASK      BIT4
#define ADC_ISR_JEOC_MASK       BIT3
#define ADC_ISR_JECH_MASK       BIT2
#define ADC_ISR_EOC_MASK        BIT1
#define ADC_ISR_ECH_MASK        BIT0

/* SW Status */
#define ADC_ERR_BAD_INSTANCE    BIT0

#define ADC_ERR_INVALID_RESULT  BIT1

#define ADC_ERR_INVALID_CH      BIT2

#define ADC_ERR_ONGOING_CONV    BIT3

/* ADCConfig_t Masks */
#define ADC_DATA_CAN_BE_OVERWRITTEN        (0x80000000u)
#define ADC_DATA_CANT_BE_OVERWRITTEN       (0X00000000u)
#define ADC_DATA_IS_ALIGNED_LEFT           (0x40000000u)
#define ADC_DATA_IS_ALIGNED_RIGHT          (0x00000000u)
#define ADC_IS_IN_SCAN_MODE                (0x20000000u)
#define ADC_IS_IN_ONE_SHOT_MODE            (0x00000000u)
#define ADC_CTU_IS_ON                      (0x10000000u)
#define ADC_CTU_IS_OFF                     (0x00000000u)
#define ADC_AUTOCLOCK_OFF_EN               (0x08000000u)
#define ADC_AUTOCLOCK_OFF_DIS              (0x00000000u)

#define ADC_EO_CTU_CONV_ISR_EN             (0x04000000u)
#define ADC_EO_CTU_CONV_ISR_DIS            (0x00000000u)
#define ADC_EO_INJ_CHAN_CONV_ISR_EN        (0x02000000u)
#define ADC_EO_INJ_CHAN_CONV_ISR_DIS       (0x00000000u)
#define ADC_EO_INJ_CHAIN_CONV_ISR_EN       (0x01000000u)
#define ADC_EO_INJ_CHAIN_CONV_ISR_DIS      (0x00000000u)
#define ADC_EO_CHAN_CONV_ISR_EN            (0x00800000u)
#define ADC_EO_CHAN_CONV_ISR_DIS           (0x00000000u)
#define ADC_EO_CHAIN_CONV_ISR_EN           (0x00400000u)
#define ADC_EO_CHAIN_CONV_ISR_DIS          (0x00000000u)
#define ADC_DMA_CLEARED_ON_READ            (0x00200000u)
#define ADC_DMA_CLEARED_ON_ACK             (0x00000000u)
#define ADC_DMA_EN                         (0x00100000u)
#define ADC_DMA_DIS                        (0x00000000u)
#define ADC_IS_CLOCKING_FULL_SPEED         (0x00080000u)
#define ADC_IS_CLOCKING_HALF_SPEED         (0x00000000u)
#define ADC_PR_INPLATCH_SET                (0x00008000u)
#define ADC_PR_INPLATCH_CLEAR              (0x00000000u)
#define ADC_PR_LSB_ROUND_DOWN              (0x00004000u)
#define ADC_PR_LSB_ROUND_UP                (0x00002000u)
#define ADC_PR_LSB_NO_ROUNDING             (0x00000000u)
#define ADC_PR_INPCMP_1                    (0x00000200u)
#define ADC_PR_INPCMP_2                    (0x00000400u)
#define ADC_PR_INPCMP_3                    (0x00000600u)

/* ADCChConfig_t Masks */
#define ADC_CH_ISR_EN                      (0x80000000u)
#define ADC_CH_ISR_DIS                     (0x00000000u)
#define ADC_CH_DMA_EN                      (0x40000000u)
#define ADC_CH_DMA_DIS                     (0x00000000u)

/* ADCChConfig_t Presets for speed */
#define ADC_LOW_SPEED_CONFIG (ADC_PR_INPLATCH_SET | ADC_PR_INPCMP_3 | \
                              ADC_PR_INPSAMP(255u))
/*** Function Macros ***/
#ifndef N_ELEMENTS
#define N_ELEMENTS(X)           (sizeof(X)/sizeof(*(X)))
#endif

/* ADCChConfig_t Macros */
#define ADC_PR_INPSAMP(XX)                 (XX << 16u)
/*** Enums ***/
enum ADC_CHANNELS /* Note that Pictus only has 16 channels per instance */
{
  ADC_CH0 = 0u, ADC_CH1, ADC_CH2, ADC_CH3, ADC_CH4, ADC_CH5, ADC_CH6, ADC_CH7,
  ADC_CH8, ADC_CH9, ADC_CH10, ADC_CH11, ADC_CH12, ADC_CH13, ADC_CH14, ADC_CH15,
  ADC_CH16, ADC_CH17, ADC_CH18, ADC_CH19, ADC_CH20, ADC_CH21, ADC_CH22,
  ADC_CH23, ADC_CH24, ADC_CH25, ADC_CH26, ADC_CH27, ADC_CH28, ADC_CH29,
  ADC_CH30, ADC_CH31, ADC_CH32, ADC_CH33, ADC_CH34, ADC_CH35, ADC_CH36,
  ADC_CH37, ADC_CH38, ADC_CH39, ADC_CH40, ADC_CH41, ADC_CH42, ADC_CH43,
  ADC_CH44, ADC_CH45, ADC_CH46, ADC_CH47, ADC_CH48, ADC_CH49, ADC_CH50,
  ADC_CH51, ADC_CH52, ADC_CH53, ADC_CH54, ADC_CH55, ADC_CH56, ADC_CH57,
  ADC_CH58, ADC_CH59, ADC_CH60, ADC_CH61, ADC_CH62, ADC_CH63, ADC_CH64,
  ADC_CH65, ADC_CH66, ADC_CH67, ADC_CH68, ADC_CH69, ADC_CH70, ADC_CH71,
  ADC_CH72, ADC_CH73, ADC_CH74, ADC_CH75, ADC_CH76, ADC_CH77, ADC_CH78,
  ADC_CH79, ADC_CH80, ADC_CH81, ADC_CH82, ADC_CH83, ADC_CH84, ADC_CH85,
  ADC_CH86, ADC_CH87, ADC_CH88, ADC_CH89, ADC_CH90, ADC_CH91, ADC_CH92,
  ADC_CH93, ADC_CH94, ADC_CH95
};

/*** TypeDefs ***/
typedef volatile struct ADC_tag* ADC_t;

typedef union
{
  struct
  {
    uint32_t OverWriteEn :1;
    uint32_t LeftAligned :1;
    uint32_t ScanModeEn :1;
    uint32_t CTUEn :1;
    uint32_t AutoClockEn :1;
    uint32_t EOCTUIsrEn :1;
    uint32_t JEOCIsrEn :1;
    uint32_t JEOCHIsrEn :1;
    uint32_t EOCIsrEn :1;
    uint32_t EOCHIsrEn :1;
    uint32_t DMAClrOnRead :1;
    uint32_t DMAEn :1;
    uint32_t ClkSel :1;
    uint32_t Reserved :3;
    uint32_t LatchPhaseDuration :1;
    uint32_t Reserved0 :1;
    uint32_t OffShiftConfig :2;
    uint32_t Reserved1 :1;
    uint32_t ComparisonPhaseDuration :2;
    uint32_t Reserved2 :1;
    uint32_t SamplingPhaseDuration :8;
  } P;
  struct
  {
    uint16_t Mixed;
    uint16_t CTR;
  } R;
  uint32_t W;
} ADCConfig_t;

typedef union
{
  struct 
  {
    uint32_t ChIsrEn :1; /* Not functional */
    uint32_t ChDMAEn :1;
    uint32_t Reserved2 :17;
    uint32_t DMACh: 4;
    uint32_t Instance :1;
    uint32_t Channel :8;
  } P;
  uint32_t W;
} ADCChConfig_t;

/*
 **************************************************************
 * Declarations 
 **************************************************************/
/*** Extern ***/

/*** Globals ***/

/*** Static Globals ***/

/*
 **************************************************************
 * Function Prototypes 
 **************************************************************/
/*
 ******************************************************************************
 *
 * Function:          u8fnADCConvert()
 *
 */
uint8_t u8fnADCConvert(const uint8_t cu8ADCInstance,
                       const uint8_t cu8ADCCh,
                       uint16_t* pu16Result);
/*
 ******************************************************************************
 *
 * Function:          u8fnADCConfig()
 *
 */
uint8_t u8fnADCConfig(uint8_t u8Instance, ADCConfig_t* ptADCConfig);
/*
 ******************************************************************************
 *
 * Function:          u8fnADCSelectRegIndex()
 *
 */
static uint8_t u8fnADCSelectRegIndex(uint8_t u8Channel, uint16_t* pu16Mask);
/*
 ******************************************************************************
 *
 * Function:          u8fnADCChannelConfig()
 *
 */
uint8_t u8fnADCChannelConfig(const ADCChConfig_t* tADCChConfig,
                             const uint16_t* pu16Results);
/*
 ******************************************************************************
 *
 * Function:          u8fnADCReadChannel()
 *
 */
uint8_t u8fnADCReadChannel(uint8_t u8Instance,
                           uint8_t u8Channel,
                           uint16_t* pu16ADCResult);
/*
 ******************************************************************************
 *
 * Function:          u8fnADCStatus()
 *
 */
uint8_t u8fnADCStatus(uint8_t u8Instance);
/*
 ******************************************************************************
 *
 * Function:          u8fnADCNormalConversionEnable()
 *
 */
uint8_t u8fnADCNormalConversionEnable(uint8_t u8Instance, uint8_t u8Enable);
/*
 ******************************************************************************
 *
 * Function:          vfnADCEoCIsr()
 *
 */
static void vfnADCEoCIsr(uint8_t u8Instance);
/*
 ******************************************************************************
 *
 * Function:          vfnADC0EoCIsr()
 *
 */
void vfnADC0EoCIsr(void);
/*
 ******************************************************************************
 *
 * Function:          vfnADC1EoCIsr()
 *
 */
void vfnADC1EoCIsr(void);
/*
 ******************************************************************************
 *
 * Function:          vfnADC1ErrIsr()
 *
 */
static void vfnADCErrIsr(uint8_t u8Instance);
/*
 ******************************************************************************
 *
 * Function:          vfnADC0ErrIsr()
 *
 */
void vfnADC0ErrIsr(void);
/*
 ******************************************************************************
 *
 * Function:          vfnADC1ErrIsr()
 *
 */
void vfnADC1ErrIsr(void);
/*
 ******************************************************************************
 *
 * Function:          vfnADCWatchDogIsr()
 *
 */
static void vfnADCWatchDogIsr(uint8_t u8Instance);
/*
 ******************************************************************************
 *
 * Function:          vfnADC0WatchDogIsr()
 *
 */
void vfnADC0WatchDogIsr(void);
/*
 ******************************************************************************
 *
 * Function:          vfnADC0WatchDogIsr()
 *
 */
void vfnADC1WatchDogIsr(void);

#endif /* _FILENAME_H */